home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
The Arsenal Files 6
/
The Arsenal Files 6 (Arsenal Computer).ISO
/
os2bbs
/
mxl220.zip
/
TEMPLATE.DOC
< prev
next >
Wrap
Text File
|
1996-02-17
|
38KB
|
958 lines
┌╦═══════════════════════════════════════════════════════════════════ ┌╦═══╦┐
│║ ┌╦ ╦┐┌╦ ╦┐┌╦═╦═╦┐┌╦═╦═╦┐┌╦ ┌╦═══╦┐ ┌╦══╦┐ ┌╦══╦┐ │║ ╩┘
└╩═══╦┐├╬═══╬┤│║ ║│ ║ ║ │║ ├╬══ │╠══╩╦┐│╠══╩╦┐└╩═══╦┐
┌╦ ║│└╩ ╩┘└╩═══╩┘ ╩ ╩ └╩═══╩┘└╩═══╩┘ └╩═══╩┘└╩═══╩┘ ║│
└╩═══╩┘ ════════════════════ H A T T I N G E N ══════════════════════════╩┘
▓▒░ ─────────────────────────────────────────── ░▒▓
▓▒░─────────────▓▒░ HOME OF MAXLIST FILELISTPROCESSOR ░▒▓─────────────░▒▓
▓▒░ ─────────────────────────────────────────── ░▒▓
═══════════════════════════════════════════════════════════════════════════
▓▒░ ░▒▓
▓▒░ ┌──────┐ ┌──────┐ ┌─┐ ┌─┐ ┌─┐ ┌─┐ ┌──────┐ ┌───────┐ ░▒▓
▓▒░ └──────┘ └──────┘ └─┘ └─┘ └─┘ └─┘ └──────┘ └───────┘ ░▒▓
▓▒░ ┌─┐┌┐┌─┐ ┌──────┐ ┌──┐ ┌─┐ ┌─┐ ┌──────┐ ┌─┐ ░▒▓
▓▒░ │ │└┘│ │ │ ┌──┐ │ ┌┘┌┐└┐ │ │ │ │ └────┐ │ │ │ ░▒▓
▓▒░ │ │ │ │ │ │ │ │ ┌┘┌┘└┐└┐ │ └────┐ │ │ ┌────┘ │ │ │ ░▒▓
▓▒░ └─┘ └─┘ └─┘ └─┘ └─┘ └─┘ └──────┘ └─┘ └──────┘ └─┘ ░▒▓
▓▒░ Template controlled Filebaseprozessor for Maximus Systems ░▒▓
▓▒░ Version 2.20 Copyright 1994-96 by Wilfried Brinkmann ░▒▓
▓▒░ ░▒▓
▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ All rights reserved ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
═════════════════════════════════════════════════════════════════════════════
───────────────────────────────────────────────────────
Documentation and Overview of MaxList Template-Tokens
═══════════════════════════════════════════════════════
MaxList uses templates for ALL output in file lists and FILES.BBS files.
They contain the information how to format the header and the single
lines.
Common Information
────────────────────
There is no limit in the length of a line for template files as well as
for file descriptions. A template or one file description may be maximum
8 kB in total. If this value is exceeded, they will be trucated SILENTLY
to a length of 8192 characters!
The internal buffer of course is not limited to 8 kB, in order to be able
to perform reformatting.
As it is likely that a large amount of tokens may occur on one line, the
text will soon get unreadable or unprocessable if you write all in one
line.
Therefore it is possible to insert a continuation character in order to
have physical line feeds in a file without breaking the logical line.
This means that a logical line can extend to several lines of text.
The continuation characted is a backslash "\".
Example:
@Format(@FileName @FileSize(#######) \
@FileDate(DD.MM.YYF) \
@Adjust("@AreaName",l,15,t) @Adjust("@FilePath",l,32,t))
The whole block above is displayed in one line later on.
The \ character, as well as any following blank or CR/LF is removed.
At the end of the whole string ONE CR/LF is added, nevertheless how
many of them occur in the text.
If you want to use the \ itself, you have to quote it by writing two
backslashes (\\). This will translate to one backslash in display.
"Backslash \\ in text" thus translates to "Backshlash \ in text".
It is possible to use MECCA color tokens in the BBS header templates.
They are translated by MaxList.
The following MECCA tokens are available:
[cls] - clear screen
Colors:
Foreground and Background Foreground only
------------------------- ---------------
[black] [darkgray]
[blue] [lightblue]
[green] [lightgreen]
[cyan] [lightcyan]
[red] [lightred]
[magenta] [lightmagenta]
[brown] [yellow]
[gray] [white]
In order to set foreground and background color simultaneously you MUST
use the token ON, e.g. [white ON blue].
The CLS token may be grouped together with color tokens, e.g.
[CLS red on blue].
If you need the bracket ([) as normal character in the text, you have to
double it ([[), e.g. [CLS WHITE][[White] [[[YELLOW]Yellow[WHITE]].
MaxList automatically adds the MECCA token [left cr lf] at the end of
each line in the BBS header. By this sequence of characters MaxList
recognizes the header and so is able to remove it again.
No extensive syntax check is done by MaxList. So the result may be
unpredictable if you miswrote some tokens or made errors when setting
the brackets.
Therefore note once again:
SET THE DEBUG MODE OF MAXLIST FOR YOUR FIRST TRIES !!!!
This is the only possibility to avoid changes to FILES.BBS files.
MaxList will then place it's output in a file named FILES.$$$ instead
of changing the original FILES.BBS.
The Templates
───────────────
The following section lists all templates, their function and their valid
place.
Five types of templates are available: BBS, AREA, GROUP, REPORT and TITLE.
The types AREA, GROUP and REPORT each seperate into HEADER and FOOTER, so
that eight templates are available in total.
The template types HEADER of BBS, AREA and GROUP each contain a statement
how the single file description lines should look like.
This statement reads @FORMAT(@ID @ID ... @ID) and it MUST be the last
statement in this template.
If you do not want to have a header you have to write this statement
(only this statement) in either case!
The arguments (@ID) have to consist of the single tokens for file name,
file size, date, description etc.
The possible arguments depend on the kind of template. Unresolvable
tokens are removed. If they are written within an @ADJUST statement, an
empty string is used instead then!
The BBSHEADER Template
──────────────────────
You may specify a special header for the FILES.BBS files for each area
or group. But take into consideration that ALL templates must permanently
remain in main memory. So things are limited under DOS.
At least one BBSHEADER should be specified. Otherwise MaxList will use
an internal one which may not be altered.
The internal BBSHEADER has the following format:
@Format(@FileName FileDesc(31, 79))
IMPORTANT NOTE FOR MAXIMUS 3.0 USERS!
─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─
MaxList supports a special kind of FILES.BBS format which contains both
file size and file date in addition to the normal entries.
This special format is defined by a
TYPE DATELIST
statement in the area definition block in Maximus 3.0.
In this special case a template is needed where the @FORMAT statement
looks like this:
@Format(@FileName \
@FileSize(#######_f)@FileDate(MM-DD-YY__)\
@FreeDwnLd@DlCounter@FileDesc(31,79))
You may change the border size at @FILEDESC to your need. Furthermore
@FREEDWNLD and @DLCOUNTER may be left out, if you do not need them.
The most simple @FORMAT statement should then look like this:
@Format(@FileName \
@FileSize(#######_f)@FileDate(MM-DD_YY__)@FileDesc(31,79))
NOTE:
You may also use this @FORMAT statement for areas which are not of
TYPE DATELIST. In this case MaxList will NOT print any file size or
date in the FILES.BBS files. This way it is possible to have ONE
template for ALL areas! This template is located in the archive as
BBSHDR3.TPL.
The LISTTITLE Template
──────────────────────
Optional you may use a title template. So it is possible to insert e.g.
the list type immediately after your logo (ListHeaderFile) into the list.
I use a graphical font for this title which places the listname centered.
Furthermore the date, time and day as well as the new files flags are
inserted here if the corresponding tokens are given. For an example see
the file TITLE.TPL
The AREA Templates (AreaHeader / AreaFooter)
────────────────────────────────────────────
You may specify two templates for each area: AreaHeader and AreaFooter.
The footer is optional. A @FORMAT statement MUST be present in the
header.
The header is printed at the beginning of each area. It is followed by
the single file description entries. At the end of each area a footer
may be printed OPTIONALLY.
When the DUPE list is generated, the AreaHeader and the @FORMAT statements
contained herein are used to list the dupe files. For an example see the
template file DUPEHDR.TPL.
The GROUP Templates (GroupHeader / GroupFooter)
───────────────────────────────────────────────
These two templates are required by the report part of a list.
The GroupHeader must contain a @FORMAT statement, the GroupFooter is
optional.
The GroupHeader is printed before any area of this group, followed by
all area entries for that group.
The REPORT Templates (ReportHeader / ReportFooter)
──────────────────────────────────────────────────
These two templates are optional.
ReportHeader is written to the beginning of the statistics of a list,
ReportFooter at the end, immediately before my copyright notice.
In the report templates no @FORMAT statement is required.
Schematic Structure of a File List
──────────────────────────────────
┌───────────────────────────────────┐
│ FileListHeader (Optional) │
│ ... │
├───────────────────────────────────┤
│ ListTitle (Optional) │
│ Date, time, name, flags │
╞═══════════════════════════════════╡ ──┐
│ AreaHeader with @Format statement │ │
├ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┤ │
│ File Description │ │
│ ... │ │
│ File Description │ ├── Omitted at report lists.
├ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┤ │ Dupe lists will contain
│ AreaFooter (Optional) │ │ only one AreaHeader.
├───────────────────────────────────┤ │
│ ... additional Areas │ │
╞═══════════════════════════════════╡ ══╡
│ ReportHeader (Optional) │ │
├───────────────────────────────────┤ │
│ GroupHeader with @Format statement│ │
├ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┤ │
│ Areas of this Group │ │
│ ... │ ├── Only when AllAreaReport
│ Areas of this Group │ │ set to YES.
├ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┤ │ Always at report lists.
│ GroupFooter (Optional) │ │
├───────────────────────────────────┤ │
│ ... additional Groups │ │
├───────────────────────────────────┤ │
│ ReportFooter (Optional) │ │
╞═══════════════════════════════════╡ ──┘
│ FileListFooter (Optional) │
│ ... │
├───────────────────────────────────┤
│ Copyright Logo │
└───────────────────────────────────┘
Example of a new files list with title, AreaHeader, GroupHeader and
───────────────────────────────────────────────────────────────────
ReportHeader:
─────────────
█▄ █ █▀▀▀▀ █ █ █▀▀▀▀ ▀█▀ █ █▀▀▀▀ ▄▀▀▀▀
▀▀▀▀▀ █ ▀▄█ █▀▀▀ █▄▀▄█ █▀▀▀ █ █ █▀▀▀ ▀▀▀▄ ▀▀▀▀▀
▀ ▀ ▀▀▀▀▀ ▀ ▀ ▀ ▀▀▀ ▀▀▀▀▀ ▀▀▀▀▀ ▀▀▀▀
This list was created at 22:50 on Monday, 05.Feb 96 by MAXLIST+ v2.20
All files are less than 30 days old.
═══════════════════════════════════════════════════════════════════════════════
▄▀▀▀▄ ║ Local Echo
▄▀▀ ║ Available: 3 files (236.918 Bytes)
▀▀▀▀▀ ║ Newest: FRO_PWAD.ZIP (03.09.1995, 79084 Bytes)
───────────────────────────────────────────────────────────────────────────────
Filename Size Date Description
──────────── ─────── ───────── ────────────────────────────────────────────────
CTFILES.ZIP 24944 01.09.95 Alle neuen C't Files
FRO_PWAD.ZIP 79084 03.09.95 Frodo PWAD for DOOM2 and Heretic
DOOM2 level 1, 2, and 3
Heretic e1m1, m2, and m3
GERFAQ4A.ZIP 132890 29.08.95 FAQ zu OS/2 Warp 3, deutschsprachige
Ausgabe 3a v. 03.03.95, TXT und INF.
╒═════════╤═════════════════════════════════════════════════════════╤═════════╕
│░▒▓███▓▒░│ NEWFILES SUMMARY │░▒▓███▓▒░│
│░▒▓███▓▒░├─────────────────────────────────────────────────────────┤░▒▓███▓▒░│
│░▒▓███▓▒░│ 72 files (5.553 Kb) in 24 Areas (6 Groups) │░▒▓███▓▒░│
╘═════════╧═════════════════════════════════════════════════════════╧═════════╛
Group: GFD.APP - Gfd-Net Applicationen
Available: 9 files (694 Kb) in 3 areas
═══════════════════════════════════════════════════════════════════════════════
Area Description Files Bytes
───────────────── ─────────────────────────────────────────── ────── ──────────
GFD.APP.ARC Archiver 3 231K
GFD.APP.BACK Backup Tools 3 231K
GFD.APP.EDIT Editoren 3 231K
Group: GFD.FNT - Gfd-Net Mailbox Programm
Available: 18 files (1.388 Kb) in 6 areas
═══════════════════════════════════════════════════════════════════════════════
Area Description Files Bytes
───────────────── ─────────────────────────────────────────── ────── ──────────
GFD.FNT.BBS BBS Programme 3 231K
GFD.FNT.DOOR Door Programme 3 231K
GFD.FNT.MISC Diverse Tools 3 231K
GFD.FNT.PNT Pointprogramme 3 231K
GFD.FNT.TOSS Tosser 3 231K
Available: 3 files (231 Kb) in 1 area
═══════════════════════════════════════════════════════════════════════════════
Area Description Files Bytes
───────────────── ─────────────────────────────────────────── ────── ──────────
2 Lokales Echo 3 231K
╒═══════════════════════════════════════════════════════════════════════╕
│ This list was produced by MAXLIST+ (Version 2.20∙OS2) │
│ Copyright 1994/95 by Wilfried Brinkmann, 45529 Hattingen, Germany │
╘═══════════════════════════════════════════════════════════════════════╛
Registered to: Wilfried Brinkmann
The Template Tokens
─────────────────────
The following section describes all tokens available in the templates.
For each token the valid template types or valid sections in an
template are explained.
Sometimes the same tokens will have a different result. This occurs
especially at sums (e.g. @FILES token).
EVERY token starts with a "@" (the german word for this character is
Klammeraffe, which would translate to "bracket monkey" in english,
but this surely is not the right translation. Sorry, the translator ;)
If a token has parameters, these have to be put in paranthesis "( )".
The single parameters within the paranthesis are seperated by a comma ",".
There is no difference in upper/lower case writing. The tokens may be
stacked into each other as you like, i.e. further tokens may be used as
parameters of one token.
Example: @Adjust(@Adjust(@Adjust("Test1",l,5),l,10),r,20)
Optional parameters are diplayed in [brackets]. The brackets themselves
of course have NOT be given in a template.
When several parameters are allowed but not all of them are needed, the
unused part may be omitted. Nevertheless you have to give the commas then.
Example: @FileDesc(31,79,,TF)
@FORMAT
───────
Syntax: @Format(@ID @ID .... @ID)
This statement is used, as mentioned above, for the format of one single
file description in a FILES.BBS or list.
It MUST be present in the following templates:
BBSHeader - For Files.bbs
AreaHeader - For file lists
GroupHeader - For report lists
In all other templates this statement is superfluous. When MaxList finds
it never the less, it will be ignored.
Example of a @FORMAT statement:
@Format(@FileName @FreeDwnLd@DlCounter@Filedesc(31,79))
After processing the resulting FILES.BBS will look like this:
NWFAQ503.ARJ /bt [00] Novell FAQ Version 03/95 ASCII-Version
deutschsprachige FAQ ueber alles, was
mit Novell zu tun hat.
inkl. aktueller File- und Mailboxliste
@LISTTYP
────────
Syntax: @ListTyp
Templates: All except BBS and @FORMAT statement
This token prints the list type.
Available list types:
ALL [Name] - [Name] or ALLFILES
NEW <days> [Name] - [Name] or NEWFILES
PART [Name] - [Name] (when given)
REPORT [Name] - [Name] or REPORT
DUPE [Name] - [Name] or DUPES
ORHAN [Name] - [Name] or ORPHAN
ANNOUNCE [Name] - [Name] or ANNOUNCE
!!! IMPORTANT NOTE:
When @ListTyp is used within @TEST, not the Name of the list,
but the name of the type will be used for comparision.
@Test(@ListTyp,=,All, ...) is TRUE, if the list is of type ALL.
@TEST
─────
Syntax: @Test(@ID1, <|=|>|<>|[], @ID2, @IDTrue, @IDFalse)
Templates: All
For testing of parameters. @ID1 is compared to @ID2.
Valid operators are:
< - less than
= - equal to
> - greater than
<> - not equal
[] - in range
Dependent on the result @IDTrue or @IDFalse is processed.
Examples: @Test(@Groups,>,1,(@Groups Groups),"")
The sum of groups is only printed when it is greater than 1.
@Test(@AreaTag,[],12..99,"Top Secret",@AreaTag)
If the Areatag in 12 to 99, than "Top Secret" is printig,
otherwise the Areatag is written.
@FILEPATH
─────────
Syntax: @FilePath
Templates: All except TitleTemplate and BBS
Drive and Path(s) as given in DownLoad, e.g. D:\LISTS\SHUTTLE\.
If the FILES.BBS contains a path name in the file name, this value is
taken.
@FILENAME
─────────
Syntax: @FileName
Templates: In all @FORMAT statements
Prints the Name of a file leftbound with a length of 12 characters.
When the name is shorter than 12 characters it is filled with blanks,
e.g.: "ABC.ZIP_____"
Any path in the FILES.BBS is NOT printed in the lists, but remains in
the FILES.BBS.
@FILEDATE
─────────
Syntax: @FileDate(DateFormat)
Templates: In all @FORMAT statements
You may format the date as you like. The parameter DateFormat may NOT be
omitted. The following placeholders may be specified:
D - Day 01 .. 31
M - Month 01 .. 12, or name of month (Jan, Feb etc)
Y - Year
F - Flag for new file
If a file is older than specified for any flag, a blank will
be printed.
_ - Underscore, replaced by one blank
Examples:
DateFormat: Result:
----------- ---------
DD.MM.YY - 20.09.95
MM.YYYY - 09.1995
DD-MM-YYF - 20-09-95+
D.M.YF - 20.09.95+
DD.MMM_YYYY - 20.Sep 1995
D.M.YYY - 20.09.1995
DD-MM-YYF_ - 20-09-95+_ (_ is a Blank)
@FILESIZE
─────────
Syntax: @FileSize(SizeFormat)
Templates: In all @FORMAT statements
Size of a file. The number may be formatted and converted to other size
units (Kb Mb etc.) as you like. Internally it is counted in bytes and
may be converted to kilobytes (div 1024) and megabytes (div 1048576).
NOTE:
NO conversion is allowed in the BBS templates for TYPE DATELIST.
The format for this template MUST look like this:
@FileSize(#######_F)
Formatting character:
# - replaced by a number
K - conversion to kilobytes
M - conversion to megabytes
F - fill with blanks
_ - Underscore, replaced by one blank
ATTENTION: The chars K, M, F NEED to be placed at the end!
Examples:
SizeFormat: Result:
---------------------------- ----------
None (Empty paranthesis) 123456789
One or more # 123456789
#.###.### 12.346.789
K (conversion kilobytes) 120563
#.###.###K 120.563
M (conversion megabytes) 117
#.###.###M 117
#.###F 123456.789
#######MF ____117 (_ represents one blank)
#.###_M 117_ (_ represents one blank)
@FREEDWNLD
──────────
Syntax: @FreeDwnLd
Templates: Only in @FORMAT statement in BBS templates
Prints the corresponding string (when defined in the configuration file
at FreeDownLoad) and an additional blank. When FreeDownLoad is not
valid for this area or group, then nothing is printed.
Possible results are "/b ", "/t " or "/tb ".
@DLCOUNTER
──────────
Syntax: @DLCounter
Templates: Only in @FORMAT statement in BBS and AREA templates
When a download counter (DLCounter) is specified in the configuration,
it will be printed when none is already present in the FILES.BBS.
If a download counter is already present in the FILES.BBS it will be used
and remains unchanged.
When a DLCounter is specified in the configuration, but this token is
NOT used in the BBS or AREA template, any existing download counter
where the brackets match those of DLCounter is removed without grace!
If no DLCounter is specified in the configuration, this token will be
ignored.
NOTE: An additional blank is added, when a download counter is printed!
@AREANAME
─────────
Syntax: @AreaName
Templates: All except TitleTemplate
Prints the WHOLE name of an area, including FileDivisions.
If an area EDIT is located in group GFD.APP, the result will be
"GFD.APP.EDIT".
@AREATAG
────────
Syntax: @AreaTag
Templates: All except TitleTemplate
Prints the name of an area without FileDivisions. For area EDIT the
result is "EDIT".
@GROUPTAG
─────────
Syntax: @GroupTag
Templates: All except TitleTemplate
Prints the name of the group, e.g. "GFD.APP".
The area name is not printed.
@AREADESC / @GROUPDESC
──────────────────────
Syntax: @AreaDesc / @GroupDesc
Templates: All except TitleTemplate
Prints the description for an area or a group. The length of
this description is limited internally to 50 characters.
@AREAACS / @GROUPACS
────────────────────
Syntax: @AreaAcs / @GroupAcs
Templates: All except TitleTemplate
Prints AccessLevel and Keys of an area or group.
If you defined a translation in the configuration (USERLEVEL) the
string defined there is printed. Otherwise the level/keys are printed
as defined at the corresponding area or group.
The length of the access string is limited internally to 50 characters.
@OFFLINE
────────
Syntax: @OffLine
Templates: Only in @FORMAT statement of AREA templates
All "normal" file list processors print an offline string instead of
file size and date if the file is not present in the file base.
As MaxList allows the parameters to be put on any place, another method
is neccessary for inserting the offline string defined in the
configuration.
If an offline string should be printed, you have to define it by using
the @Test token. Example:
@Format(@FileName \
@Test(@FileSize(),>,0,\
@FileSize(#######F) @FileDate(DD.MM.YYF),\
@Adjust("@OffLine",l,17)) @Filedesc(31,79))
MaxList sets the file size to 0 when a file is not accessible. This means
that a 0 byte file is regarded as not present either!
The above code tests the file size to be greater than 0, if that is true,
@FileSize(#######F) @FileDate(DD.MM.YYF) is printed after the file name.
When the file size is 0, @Adjust("@OffLine",l,17) is used instead.
@NEWFNAME
─────────
Syntax: @NewFName
Templates: AREA and BBS templates, but not in @FORMAT statement
Name of the NEWEST file in this area.
The name is not formatted in any way. It will be printed as found in
the FILES.BBS file.
@NEWFDATE
─────────
Syntax: @NewFDate(DateFormat)
Templates: AREA and BBS templates, but not in @FORMAT statement
Date of the NEWEST file in this area.
The format of parameter DateFormat is the same as described at @FILEDATE.
@NEWFSIZE
─────────
Syntax: @NewFSize(SizeFormat)
Templates: AREA and BBS templates, but not in @FORMAT statement
Size of the NEWEST file in this area.
The format of parameter SizeFormat is the same as described at @FILESIZE.
@FILES
──────
Syntax: @Files
Templates: All except in @FORMAT statement
Prints the unformatted sum of files. It depends on the template:
AREA / BBS - sum of all files in this area
GROUP - sum of all files in this group
REPORT - sum of all files in this list
@BYTES
──────
Syntax: @Bytes(SizeFormat)
Templates: All except in @FORMAT statement
Returns the sum of bytes.
The format of parameter SizeFormat is the same as described at @FILESIZE.
The output depends on the template:
AREA / BBS - sum of the bytes of all files in this area
GROUP - sum of the bytes of all files in this group
REPORT - sum of the bytes of all files in this list
@AREAS
──────
Syntax: @Areas
Templates: Only in GROUP and REPORT
Returns the sum of areas. The output depends on the template:
GROUP - sum of all areas in this group
REPORT - sum of all areas in this list
@GROUPS
───────
Syntax: @Groups
Templates: Only in REPORT
Returns the sum of all groups in the list.
If you do not use FileDivisions, the sum of groups is 1.
(MainGroup = group without FileDivisions).
This group has neither a tag, ACS or description!
@PROGNAME
─────────
Syntax: @PrgName
Templates: Only in title templates
Hmm. What could this one be? This token is replaced by the string
'MAXLIST+ v#.##'. I hope you will ALWAYS use this token ;-)
The '+' sign occurs only at registered versions of MaxList, v#.##
represents the version number of MaxList.
@DATE
─────
Syntax: @Date(DateFormat)
Templates: Only in title templates
Returns the actual date.
The format of parameter DateFormat is the same as described at @FILEDATE.
@TIME
─────
Syntax: @Time(TimeFormat)
Templates: Only in title templates
Returns the actual time.
Parameter TimeFormat is a formatting string (analog to @FILEDATE)
that may consist of the following characters:
H - hour 00 .. 23
M - minute 00 .. 59
S - second 00 .. 59
_ - underscore, is replaced by a blank
Examples:
HH:MM:SS - 22.17.05
H:M - 22:17
HH:MM.SS_ - 22:17.05_ (_ is one blank)
@DAY
────
Syntax: @Day
Templates: Only in title templates
Returns the name of the day as defined in the configuration of MaxList.
If no translation is defined in the configuration the english names for
the days are used.
@NEWFDAYS
─────────
Syntax: @NewFDays
Templates: Only in title templates
This token is replaced by <days> in the new files lists.
Examples for its usage may be found in the template TITLE.TPL
@FLAGS
──────
Syntax: @Flags(FlagFormat)
Templates: Only in title templates
@Flags prints ALL new file flags as defined at FLAGCHAR in the
configuration. They are each seperated by a comma.
The parameter FlagFormat defines how to format the data:
$ - print the flag character
# - print the number of days
_ - print one blank
Example:
If you have specified
FlagChar 7,! 14,* 30,+
in the configuration of MaxList
and in the template
@Flags($_=_#_days)
then MaxList will print the following:
! = 7 days, * = 14 days, + = 30 days.
@FONTSTR
─────────
Syntax: @FontStr(FontName, @ID), @FontStr(FontName)
Templates: All except in @FORMAT statement
Prints any desired text in a graphical font.
Parameters: FontName - name of the font as defined in the font (use
FNTMAKE(p).EXE to create your own ones or alter
the name of a font)
@ID - the text to be printed.
Previously you must have loaded a font in the configuration file
(statement LoadFont).
When NO font is loaded, NOTHING will be printed!
There are some special things to respect:
One character in a graphical font has several lines, which must
exactly at the same position in consecutive lines.
As every output may be formatted using @ADJUST, you have to specify
one @FONTSTR token for EVERY line of the font!
If you use a font having 3 lines in height, a @FONTSTR token has to
be placed at each column and row position.
FontName has to be given for EVERY occurance of @FontStr, while
parameter @ID is only valid for the FIRST occurance!
Example:
@Adjust("@FontStr(Digi3x5, -'@ListTyp'-)",c,79)@CrLf\
@Adjust("@FontStr(Digi3x5)",c,79)@CrLf\
@Adjust("@FontStr(Digi3x5)",c,79)
You may create your own fonts using a utility that comes with MaxList.
Five fonts are added to the MaxList archive (FONTS.ZIP).
@CRLF
─────
Syntax: @CrLf
Templates: All
Use this to add additional line feeds in a template.
@ADJUST
───────
Syntax: @Adjust("@ID", L|C|R, Len [, T]);
Templates: All
Formats a string left bound, centered or right bound and fills or cuts
to a given length.
@ID may contain any token except @FILEDESC.
@ID MUST always be enclosed in quotation marks.
Example:
@Adjust(" This is a test",L,20) will print | This is a test |
(the | is not printed, of course)
Text may be adjusted left-bound ("L"), centered ("C") or right-bound
("R"). The string is padded with blanks to become "Len" in length (of
course only when the string is shorter than "Len").
If the optional parameter "T" (for truncate) is given, the string will
be truncated to the length "Len" in any case.
@FILEDESC
─────────
Syntax: @FileDesc(Left, Right [,Lines [, T|TF [, PreLine]]])
Templates: Only in @FORMAT statement
Formats and prints the description for a single file.
Parameters:
Left - left border of the continued description (i.e. line 2
and above). Any value in the range of 1 to 65535 is
valid, but it must be less than the right border.
Right - right border of the description.
Any value in the range of 1 to 65535 is valid, but it
must be greater than the left border.
Lines - Optional. If given, the number of lines for one
description is limited to "Lines" lines.
Valuable for pages and pages of FILE_ID.DIZ.
If the value is set to 0, the number of lines is
unlimited (default).
Otherwise any value in the range of 1 to 65535 is valid.
T or TF - Optional. T means Truncate, TF means TruncateFirst.
Normally the description is completely new maked up
when not fitting in the borders (left - right).
When "T"runcate is specified, no make up is performed
but the too long lines are truncated at the right border.
"TF" is a important feature for people using a download
counter ;-)
When "TF" is specified, MaxList will only truncate the
FIRST line when it exceeds the right border. If MaxList
then recognizes in further processing that the desc needs
to be maked up again, the truncated part is re-inserted
again before the rest of the text is formatted.
PreLine - Optional. With this, you can create a list as a
Table. The string in PreLine is placed at the begin of
each line, was normaly holds (number of left) blanks.
Alternate you can use PreLine, to add a "+" before
each continous line. PreLine itself can contains a @ID
(i.e. @Adjust).
Example:
@FileDesc(31,79,,,@Adjust("+ ",r,31))
The product of this is following:
TEST.ZIP 12K 01.01.80 Eine Testdatei
+ mit Erweiterter
+ Beschreibung und
+ einem Pluszeichen
Other (complexe) Example:
@Format(@FileName│@FileSize(#######)│\
@FileDate(dd.mm.yyf)│\
@FileDesc(31,79,,,@Adjust("│",l,13)\
@Adjust("│",l,8)@Adjust("│",l,10)))
This will printout following:
TEST1.ZIP │ 12351│01.01.80 │Eine Testdatei
│ │ │in Tabellenform
│ │ │mit Linien.
ANYFILE.ARJ │ 12351│01.01.80 │Noch eine Datei
│ │ │in Tabellenform
═══════════════════════════════════════════════════════════════════════════════
A Last Note
═══════════
Study the example templates included with MaxList. You find them in
archive TEMPLATE.ZIP.
Please unpack them to a particular subdirectory and use a "Define"
in the MaxList configuration to specify the path.
Above is also valid for the font files and the FontMaker utility.
All fonts and the FNTMAKE(p).EXE program are located in the
archive FONTS.ZIP.
If you have designed a new font or created a nice template file please
don't hesitate to send it to me. So other MaxList users will profit
from your work.
The author, Wilfried Brinkmann
────────────────────────────────────────────────────────────────────────────
Template.Doc for MaxList 2.20 Date: February 1996